3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use Wikimedia\Http\HttpAcceptParser
;
22 use Wikimedia\Http\HttpAcceptNegotiator
;
25 * Request handler implementing a data interface for mediawiki pages.
27 * @author Daniel Kinzler
28 * @author Amir Sarabadanai
30 class PageDataRequestHandler
{
33 * Checks whether the request is complete, i.e. whether it contains all information needed
34 * to reply with page data.
36 * This does not check whether the request is valid and will actually produce a successful
39 * @param string|null $subPage
40 * @param WebRequest $request
44 public function canHandleRequest( $subPage, WebRequest
$request ) {
45 if ( $subPage === '' ||
$subPage === null ) {
46 return $request->getText( 'target' ) !== '';
49 $parts = explode( '/', $subPage, 2 );
52 if ( $slot === 'main' ||
$slot === '' ) {
61 * Main method for handling requests.
63 * @param string $subPage
64 * @param WebRequest $request The request parameters. Known parameters are:
65 * - title: the page title
66 * - format: the format
67 * - oldid|revision: the revision ID
68 * @param OutputPage $output
70 * @note Instead of an output page, a WebResponse could be sufficient, but
71 * redirect logic is currently implemented in OutputPage.
75 public function handleRequest( $subPage, WebRequest
$request, OutputPage
$output ) {
76 // No matter what: The response is always public
77 $output->getRequest()->response()->header( 'Access-Control-Allow-Origin: *' );
79 if ( !$this->canHandleRequest( $subPage, $request ) ) {
80 throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $subPage ) );
85 $parts = explode( '/', $subPage, 2 );
86 if ( $subPage !== '' ) {
89 $title = $request->getText( 'target' );
92 $revision = $request->getInt( 'oldid', $revision );
93 $revision = $request->getInt( 'revision', $revision );
95 if ( $title === null ||
$title === '' ) {
96 //TODO: different error message?
97 throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
101 $title = Title
::newFromTextThrow( $title );
102 } catch ( MalformedTitleException
$ex ) {
103 throw new HttpError( 400, wfMessage( 'pagedata-bad-title', $title ) );
106 $this->httpContentNegotiation( $request, $output, $title, $revision );
110 * Applies HTTP content negotiation.
111 * If the negotiation is successful, this method will set the appropriate redirect
112 * in the OutputPage object and return. Otherwise, an HttpError is thrown.
114 * @param WebRequest $request
115 * @param OutputPage $output
116 * @param Title $title
117 * @param int $revision The desired revision
121 public function httpContentNegotiation(
127 $contentHandler = ContentHandler
::getForTitle( $title );
128 $mimeTypes = $contentHandler->getSupportedFormats();
130 $acceptHeader = $request->getHeader( 'Accept' );
131 if ( $acceptHeader !== false ) {
132 $parser = new HttpAcceptParser();
133 $accept = $parser->parseWeights( $acceptHeader );
137 '*' => 0.1 // just to make extra sure
139 // prefer the default
140 $accept[$mimeTypes[0]] = 1;
143 $negotiator = new HttpAcceptNegotiator( $mimeTypes );
144 $format = $negotiator->getBestSupportedKey( $accept );
146 if ( $format === null ) {
147 $format = isset( $accept['text/html'] ) ?
'text/html' : null;
150 if ( $format === null ) {
151 $msg = wfMessage( 'pagedata-not-acceptable', implode( ', ', $mimeTypes ) );
152 throw new HttpError( 406, $msg );
155 $url = $this->getDocUrl( $title, $format, $revision );
156 $output->redirect( $url, 303 );
160 * Returns a url representing the given title.
162 * @param Title $title
163 * @param string|null $format The (normalized) format name, or ''
164 * @param int $revision
167 private function getDocUrl( Title
$title, $format = '', $revision = 0 ) {
170 if ( $revision > 0 ) {
171 $params['oldid'] = $revision;
174 if ( $format === 'text/html' ) {
175 return $title->getFullURL( $params );
178 $params[ 'action' ] = 'raw';
180 return $title->getFullURL( $params );